home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / tbbs / prgsourc.zip / FLAGS.ZIP / FLAG.TXT < prev    next >
Text File  |  1996-03-02  |  8KB  |  230 lines
  1.    ┌────────────────────────────────────────────────────────────┐
  2.    │ <<<<                     OPTIONS                      >>>> │
  3.    └────────────────────────────────────────────────────────────┘
  4.   
  5.  
  6.    ┌───────────────────────┐
  7.    │ <border>              │
  8.    └───────────────────────┘
  9.     Either no line, a single line border, or a double ine border.
  10.     Valid values are:
  11.  
  12.     0           = No border
  13.     1           = Single line border
  14.     2           = Double line border
  15.  
  16.     This option is present with every <color> option, but may not apply
  17.     in some cases. It MUST, however, be included for compatibility.
  18.     
  19.    ┌───────────────────────┐
  20.    │ <color>               │
  21.    └───────────────────────┘
  22.     A TDBS color string, in the format foreground/background. The "/" 
  23.     is part of the string, and is required. Valid colors and codes:
  24.  
  25.     BLACK               N            MAGENTA            RB
  26.     BLUE                B            RED                R
  27.     GREEN               G            BROWN/YELLOW       GR
  28.     CYAN                BG           WHITE              W
  29.  
  30.     For BLINKING, add   *    to the foreground color code.
  31.     For HIGH INTENSITY, add   +    to the foreground color code.
  32.   
  33.     EXAMPLE:
  34.  
  35.     N/GR        = BLACK foreground, BROWN background
  36.     W+/N        = BRIGHT WHITE foreground, BLACK background
  37.     GR+*/R      = BLINKING YELLOW foreground, RED background
  38.   
  39.    ┌───────────────────────┐
  40.    │ <y1>,<x1>,<y2>,<x2>   │
  41.    └───────────────────────┘
  42.     Box coordinates. Screen coordinates start at 0,0 and extend to 23,79.
  43.         
  44.         y1,x1 ──────────────────────────────────────────────── y1,x2
  45.           │   Top,left                              Top,right    │
  46.           │                                                      │
  47.           │                                                      │
  48.           │                                                      │
  49.           │                                                      │
  50.           │   Bottom,left                        Bottom,right    │
  51.         y2,x1 ──────────────────────────────────────────────── y2,x2
  52.  
  53.    ┌───────────────────────┐
  54.    │ <file/ident>          │
  55.    └───────────────────────┘
  56.     A file or identifier listed in Sysop Flags program:
  57.     
  58.     A date item
  59.     A pick list file ( in \PIKS subdirectory ), with .PIK extension
  60.     A text or ANSI file ( in \TEXT subdirectory ), with .TXT extension
  61.  
  62.     There is no actual file for a date item, but it still must be listed 
  63.     in Sysop Flags, with an identifier. 
  64.     .PIK and .TXT files must be in the appropriate subdirectory - the 
  65.     program won't waste on-line time looking for them. When noted in 
  66.     Sysop Flags, and when referenced in a .AIL file, DO NOT include the
  67.     extension. The extension is supplied by the program. .ANS files may
  68.     be used, but they must be renamed to end in .TXT.
  69.     
  70.    ┌───────────────────────┐
  71.    │ <text>                │
  72.    └───────────────────────┘
  73.     REQUIRED text string that is displayed to the user at a location
  74.     determined by Flags as appropriate. The maximum length is 30 characters,
  75.     but a shorter length is recommended in most cases.
  76.  
  77.    ┌───────────────────────┐
  78.    │ <fpos>                │
  79.    └───────────────────────┘
  80.     The position number of the flag in the flag string. Keep in mind that
  81.     flags may be 1, 2, or 3 characters long - accidentally overwriting
  82.     another flag will cause loss of that flags stored values, while 
  83.     attempting to write beyond position 70 will cause an error.
  84.     
  85.  
  86.  
  87.    ┌────────────────────────────────────────────────────────────┐
  88.    │ <<<<                    COMMANDS                      >>>> │
  89.    └────────────────────────────────────────────────────────────┘
  90.  
  91.     Commands are placed in a text file, in many respects similar to
  92.     an .SDL file or .QAL file. If you've written either of these, 
  93.     writing an .AIL file is a snap.
  94.  
  95.     FORMAT:
  96.  
  97.     Every command MUST end with a colon character ( : ).
  98.     
  99.     Extra spaces are not allowed - the program runs as fast as possible,
  100.           and checking for extra spaces takes more on-line time and
  101.           more of your systems resources. In almost every circumstance,
  102.           spaces (other than trailing ones) will generate an error.
  103.           If you receive ANY type of error message, first look for
  104.           spaces that shouldn't be there.
  105.     
  106.     Commas, equal, less than, greater than and slash characters where shown 
  107.           in the syntax, outside of the < > delimiters, are REQUIRED.
  108.     
  109.     Each element of the command must be on the line exactly as shown in 
  110.           the syntax. Empty lines between elements of the command will
  111.           cause an error.
  112.     
  113.     Skipped lines between commands are optional. Eliminating them may give 
  114.           you a 1/100th of a second performance boost over several commands,
  115.           but that hardly seems worth the loss in readability.
  116.  
  117.     Brackets [ ] shown in the syntax indicate an option - ONE OF THEM, and
  118.           only one, MUST be chosen. Do not include the brackets.
  119.             
  120.  
  121.  COMMAND SYNTAX and EXAMPLES:
  122.  
  123. ┌──────────────────┐
  124. │ CLEAR:           │
  125. │ <y1>,<x1>        │
  126. │ <y2>,<x2>        │
  127. │ <color>,<border> │
  128. └──────────────────┘
  129.  Clears an area of the specified color at the specified coordinates, with
  130.  an optional border if <border> is eqaul to 1 or 2. The foregrond color is
  131.  only important if a border is desired.
  132.  
  133.  EXAMPLE:
  134.  
  135.  CLEAR:                  Clears the entire screen to BLACK, and creates a
  136.  0,0                         normal intensity WHITE, single line border.
  137.  23,79
  138.  W/N,1
  139.  
  140. ┌─────────────────────┐
  141. │ SHOW:<file>=<pause> │
  142. └─────────────────────┘
  143.  Displays a file in the same manner as a TYPE 1 command. Unlike a
  144.  TDBS program, you cannot pause indefinitely. If <pause> is set to 0,
  145.  there is no pause. Valid pauses range from 0 to 240 seconds (4 minutes).
  146.  You are responsible for including whatever "Press any key..." message 
  147.  that you want your users to see, and for clearing the screen after your 
  148.  mesage is displayed.
  149.  
  150.  EXAMPLE:
  151.  
  152.  SHOW:Welcome=0           Displays the file WELCOME.TXT., with no pause.
  153.                           This is used to place a pick list, date box, or
  154.                           or yes/no control inside of you text box.
  155.  
  156.  SHOW:Info=120            Displays the file INFO.TXT, then waits two
  157.                           minutes for a keypress. If there is none, the
  158.                           next command is processed.
  159.  
  160. ┌────────────────────┐
  161. │ FLAG:<flag>=<val>  │
  162. └────────────────────┘
  163.  
  164. ┌────────────────────────────┐
  165. │ A:<str#><flag#>=[X] or [.] │
  166. └────────────────────────────┘
  167.  
  168. ┌────────────────────┐
  169. │ PICK: <file>       │
  170. │ <y1>,<x1>          │
  171. │ <Ncolor>,<Hcolor>  │
  172. │ <y2>               │
  173. └────────────────────┘
  174.  
  175. ┌────────────────────┐
  176. │ VIEW: [A] or [U]   │
  177. │ <Ncolor>,<Hcolor>  │
  178. │ <file>=<text>      │
  179. └────────────────────┘
  180.  
  181.  
  182. ┌─────────────────────┐
  183. │ DATE:               │
  184. │ <y1>,<x1>           │
  185. │ <Ncolor>,<Hcolor>   │
  186. │ <ident>=<text>      │
  187. └─────────────────────┘
  188.  Use for Date-of-Birth, or any date field. THIS VALUE IS STORED IN THREE
  189.  FLAGS, so be sure not to accidentally overrun another flag. The box is
  190.  six rows, and as long as it takes to fit the text string.
  191.                      
  192.                      ┌───────────────────────────────────────┐
  193.                      │                                       │
  194.                      │ <text string is displyed here>        │
  195.                      │                                       │
  196.                      │ Date: 01/01/01                        │
  197.                      │                                       │
  198.                      └───────────────────────────────────────┘
  199.  
  200.  
  201.  
  202.  
  203. ┌────────────────────┐
  204. │ YESNO:             │
  205. │ <y1>,<X1>          │
  206. │ <Ncolor>,<Hcolor>  │
  207. │ <Y-text>/<N-text>  │
  208. └────────────────────┘
  209.  
  210.  
  211. ┌─────────────────────────┐
  212. │ IF: <file/ident>=<flag> │
  213. └─────────┬───────────────┘
  214. ┌─────────┴──────────┐
  215. │ ELSE:              │
  216. └─────────┬──────────┘
  217. ┌─────────┴──────────┐
  218. │ ENDIF:             │
  219. └────────────────────┘
  220.  
  221.  
  222.  
  223. ┌────────────────────┐
  224. │ QUIT:              │
  225. └────────────────────┘
  226.  
  227.  Leave this out, and your program won't quit. Simple enough.
  228.  
  229.  
  230.